Skip to content

Log undeclared plugin only if it is not disabled #40081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 21 commits into
base: 2.4-develop
Choose a base branch
from
Open

Log undeclared plugin only if it is not disabled #40081

wants to merge 21 commits into from

Conversation

thomas-kl1
Copy link
Member

@thomas-kl1 thomas-kl1 commented Jul 18, 2025 •
edited by m2-assistant bot
Loading

Description (*)

Developer may disable a plugin from module (A) with a third party module (B).
The plugin is referenced in di.xml thanks to its name and the attribute "disabled" is set to 'true'. The attribute "type" is not set.
If the module (A) is removed, and the referenced plugin in module (B) is not removed, Magento will report this as an error (info level) in the logs. This has effect to flood the logs with false positive cases.
Indeed, we should only log the plugin who are actually undeclared and not used (enabled and missing instance).

Manual testing scenarios (*)

Module A:

<type name="Magento\SalesRule\Model\Rule\Condition\Product">
    <plugin name="Foo_Bar::Conditions" type="Foo\Bar\Plugin\Condition\Product"/>
</type>

Remove the plugin declaration from module A (above declaration).

Module B (with sequence on Module A):

<type name="Magento\SalesRule\Model\Rule\Condition\Product">
    <plugin name="Foo_Bar::Conditions" disabled="true"/>
</type>

Expected: no logs.

Actual: logs entries:

[2025-07-18T12:18:49.535562+00:00] main.INFO: Reference to undeclared plugin with name 'Foo_Bar::Conditions'. [] []

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Log undeclared plugin only if it is not disabled #40086: Log undeclared plugin only if it is not disabled

@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Jul 18, 2025

Hi @thomas-kl1. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@lbajsarowicz
Copy link
Contributor

  1. I think this should be debug
  2. In a perfect world, I'd prefer this to be triggered only in DEV mode.

We already have tons of completely unnecessary logs about Admin menu rendering, that noone needs.

@thomas-kl1
Copy link
Member Author

Hello @lbajsarowicz I totally agree.

My description was not clear and I've tried to updated it in hope to be more understandable.
I've updated the condition to log as debug level only if the app is in developer mode, or if the actual plugin is enabled, but its instance is missing.

Thanks for your feedback!

@engcom-Hotel engcom-Hotel added Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it Priority: P2 A defect with this priority could have functionality issues which are not to expectations. labels Jul 21, 2025
@engcom-Hotel
Copy link
Contributor

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Jul 21, 2025
Open
5 tasks
engcom-Hotel
engcom-Hotel requested changes Jul 29, 2025
View reviewed changes
Copy link
Contributor

@engcom-Hotel engcom-Hotel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @thomas-kl1,

Thanks for the contribution!

The changes looks good to us, but please add some automated test in accordance to DOD.

Thanks

@engcom-Hotel
Copy link
Contributor

@magento run all tests

@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Pending Review to Changes Requested in Pull Requests Dashboard Jul 29, 2025
@thomas-kl1
Copy link
Member Author

The changes looks good to us, but please add some automated test in accordance to DOD.

OFC. I'll check the existing tests and add new ones if necessary.

@engcom-Charlie engcom-Charlie self-assigned this Aug 11, 2025
@thomas-kl1
Copy link
Member Author

@magento run all tests

@thomas-kl1
Copy link
Member Author

@magento run Integration Tests, Functional Tests CE, Functional Tests EE, Functional Tests B2B

@engcom-Charlie engcom-Charlie added the Project: Community Picked PRs upvoted by the community label Aug 12, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this to Changes Requested in Community Dashboard Aug 12, 2025
@thomas-kl1
Copy link
Member Author

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Database Compare, Functional Tests B2B, Functional Tests CE, Functional Tests EE

1 similar comment
@engcom-Hotel
Copy link
Contributor

@magento run Database Compare, Functional Tests B2B, Functional Tests CE, Functional Tests EE

engcom-Hotel
engcom-Hotel requested changes Aug 14, 2025
View reviewed changes
Copy link
Contributor

@engcom-Hotel engcom-Hotel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @thomas-kl1,

Thanks for the changes!

Please refer to the below review comment. Apart from this please refer this #40086 (comment). We are unable to reproduce the issue mentioned here.

Thanks

lib/internal/Magento/Framework/Interception/PluginListGenerator.php
private LoggerInterface $logger,
private DirectoryList $directoryList,
private array $scopePriorityScheme = ['global'],
private string $appMode = State::MODE_DEFAULT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added required parameter without default, I guess we need to handle using ObjectManager.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a mandatory argument, it's optional as State::MODE_DEFAULT is the default value.
The value is processed via DI anyway:

Magento\Framework\App\State::PARAM_MODE

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than that, the argument list didn't changed, also it's a scalar value, so I don't see how the ObjectManager could handle that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@engcom-Hotel engcom-Hotel engcom-Hotel requested changes

+1 more reviewer

@lbajsarowicz lbajsarowicz lbajsarowicz left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@engcom-Charlie engcom-Charlie

Labels
Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: needs update Project: Community Picked PRs upvoted by the community Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Community Dashboard
Status: Changes Requested
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Log undeclared plugin only if it is not disabled
4 participants
@thomas-kl1 @lbajsarowicz @engcom-Hotel @engcom-Charlie